This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/qicore-patient
Profile of Patient for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
This profile was published on Fri, Feb 27, 2015 00:00+1100 as a draft by Health Level Seven International (Clinical Quality Information - QICore).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Patient.
Summary
Mandatory: 0 element (+2 nested mandatory elements)
Must-Support: 9 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from Patient.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: IETF BCP-47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
us-core-race | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/us-core-race Binding: MU Race Value Set (preferred) |
us-core-ethnicity | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/us-core-ethnicity Binding: Ethnicity group (preferred) |
us-core-religion | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/us-core-religion Binding: v3 Code System ReligiousAffiliation (extensible) | |
birthPlace | 0..1 | Address | Extension URL: http://hl7.org/fhir/StructureDefinition/birthPlace | |
patient-disability | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-disability Binding: Disability Value Set (preferred) | |
patient-nationality | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-nationality | |
extension | 0..1 | Extension | Nationality Code | |
extension | 0..1 | Extension | Nationality Period | |
code | 1..1 | CodeableConcept | Extension URL: code Binding: ISO Country Codes (required) | |
period | 0..1 | Period | Extension URL: period | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-nationality" | |
patient-cadavericDonor | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor | |
qicore-patient-militaryService | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/qicore-patient-militaryService Binding: Military Service Codes (example) | |
patient-clinicalTrial | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial | |
NCT | 1..1 | string | Extension URL: NCT | |
url | 1..1 | uri | "NCT" | |
valueString | 1..1 | string | Value of extension | |
period | 0..1 | Period | Extension URL: period | |
url | 1..1 | uri | "period" | |
valuePeriod | 1..1 | Period | Value of extension | |
reason | 0..1 | CodeableConcept | Extension URL: reason Binding: Problem Value Set (preferred) | |
url | 1..1 | uri | "reason" | |
valueCodeableConcept | 1..1 | CodeableConcept | Value of extension | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial" | |
patient-birthTime | S | 0..1 | dateTime | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | ∑ | 0..* | Identifier | An identifier for this patient |
active | ?! S∑ | 0..1 | boolean | Whether this patient's record is in active use |
name | ∑ | 0..* | HumanName | A name associated with the patient |
telecom | ∑ | 0..* | ContactPoint | A contact detail for the individual |
iso21090-preferred | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred | |
system | ∑ I | 0..1 | code | phone | fax | email | pager | other Binding: ContactPointSystem (required) |
value | ∑ | 0..1 | string | The actual contact point details |
use | ?! ∑ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
rank | ∑ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
period | ∑ | 0..1 | Period | Time period when the contact point was/is in use |
gender | S ∑ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
birthDate | S ∑ | 0..1 | date | The date of birth for the individual |
deceased[x] | ?! S∑ | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not |
address | S ∑ | 0..* | Address | Addresses for the individual |
iso21090-preferred | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred | |
use | ?! ∑ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example: home |
type | ∑ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example: both |
text | ∑ | 0..1 | string | Text representation of the address Example: 137 Nowhere Street, Erewhon 9132 |
line | ∑ | 0..* | string | Street name, number, direction & P.O. Box etc. Example: 137 Nowhere Street |
city | ∑ | 0..1 | string | Name of city, town etc. Example: Erewhon |
district | ∑ | 0..1 | string | District name (aka county) Example: Madison |
state | ∑ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (preferred) |
postalCode | ∑ | 0..1 | string | Postal code for area Example: 9132 |
country | ∑ | 0..1 | string | Country (can be ISO 3166 3 letter code) Binding: ISO Country Codes (required) |
period | ∑ | 0..1 | Period | Time period when address was/is in use Example: {"start":"2010-03-23","end":"2010-07-01"} |
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (required) | |
multipleBirth[x] | 0..1 | boolean, integer | Whether patient is part of a multiple birth | |
photo | 0..* | Attachment | Image of the patient | |
contact | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible) | |
name | 0..1 | HumanName | A name associated with the contact person | |
telecom | 0..* | ContactPoint | A contact detail for the person | |
address | 0..1 | Address | Address for the contact person | |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?! ∑ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example: home |
type | ∑ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example: both |
text | ∑ | 0..1 | string | Text representation of the address Example: 137 Nowhere Street, Erewhon 9132 |
line | ∑ | 0..* | string | Street name, number, direction & P.O. Box etc. Example: 137 Nowhere Street |
city | ∑ | 0..1 | string | Name of city, town etc. Example: Erewhon |
district | ∑ | 0..1 | string | District name (aka county) Example: Madison |
state | ∑ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (preferred) |
postalCode | ∑ | 0..1 | string | Postal code for area Example: 9132 |
country | ∑ | 0..1 | string | Country (can be ISO 3166 3 letter code) Binding: ISO Country Codes (required) |
period | ∑ | 0..1 | Period | Time period when address was/is in use Example: {"start":"2010-03-23","end":"2010-07-01"} |
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | |
organization | I | 0..1 | Reference(QICore-Organization) | Organization that is associated with the contact |
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |
communication | S | 0..* | BackboneElement | A list of Languages which may be used to communicate with the patient about his or her health |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: IETF BCP-47 (required) | |
preferred | 0..1 | boolean | Language preference indicator | |
careProvider | 0..* | Reference(QICore-Organization | QICore-Practitioner) | Patient's nominated primary care provider | |
managingOrganization | ∑ | 0..1 | Reference(QICore-Organization) | Organization that is the custodian of the patient record |
link | ?! | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
other | ?! | 1..1 | Reference(QICore-Patient) | The other patient resource that the link refers to |
type | ?! | 1..1 | code | replace | refer | seealso - type of link Binding: LinkType (required) |
Documentation for this format |
todo
This structure is derived from Patient.
Summary
Mandatory: 0 element (+2 nested mandatory elements)
Must-Support: 9 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Patient.
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: IETF BCP-47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
us-core-race | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/us-core-race Binding: MU Race Value Set (preferred) |
us-core-ethnicity | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/us-core-ethnicity Binding: Ethnicity group (preferred) |
us-core-religion | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/us-core-religion Binding: v3 Code System ReligiousAffiliation (extensible) | |
birthPlace | 0..1 | Address | Extension URL: http://hl7.org/fhir/StructureDefinition/birthPlace | |
patient-disability | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-disability Binding: Disability Value Set (preferred) | |
patient-nationality | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-nationality | |
extension | 0..1 | Extension | Nationality Code | |
extension | 0..1 | Extension | Nationality Period | |
code | 1..1 | CodeableConcept | Extension URL: code Binding: ISO Country Codes (required) | |
period | 0..1 | Period | Extension URL: period | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-nationality" | |
patient-cadavericDonor | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor | |
qicore-patient-militaryService | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/qicore-patient-militaryService Binding: Military Service Codes (example) | |
patient-clinicalTrial | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial | |
NCT | 1..1 | string | Extension URL: NCT | |
url | 1..1 | uri | "NCT" | |
valueString | 1..1 | string | Value of extension | |
period | 0..1 | Period | Extension URL: period | |
url | 1..1 | uri | "period" | |
valuePeriod | 1..1 | Period | Value of extension | |
reason | 0..1 | CodeableConcept | Extension URL: reason Binding: Problem Value Set (preferred) | |
url | 1..1 | uri | "reason" | |
valueCodeableConcept | 1..1 | CodeableConcept | Value of extension | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial" | |
patient-birthTime | S | 0..1 | dateTime | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | ∑ | 0..* | Identifier | An identifier for this patient |
active | ?! S∑ | 0..1 | boolean | Whether this patient's record is in active use |
name | ∑ | 0..* | HumanName | A name associated with the patient |
telecom | ∑ | 0..* | ContactPoint | A contact detail for the individual |
iso21090-preferred | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred | |
system | ∑ I | 0..1 | code | phone | fax | email | pager | other Binding: ContactPointSystem (required) |
value | ∑ | 0..1 | string | The actual contact point details |
use | ?! ∑ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
rank | ∑ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
period | ∑ | 0..1 | Period | Time period when the contact point was/is in use |
gender | S ∑ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
birthDate | S ∑ | 0..1 | date | The date of birth for the individual |
deceased[x] | ?! S∑ | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not |
address | S ∑ | 0..* | Address | Addresses for the individual |
iso21090-preferred | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred | |
use | ?! ∑ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example: home |
type | ∑ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example: both |
text | ∑ | 0..1 | string | Text representation of the address Example: 137 Nowhere Street, Erewhon 9132 |
line | ∑ | 0..* | string | Street name, number, direction & P.O. Box etc. Example: 137 Nowhere Street |
city | ∑ | 0..1 | string | Name of city, town etc. Example: Erewhon |
district | ∑ | 0..1 | string | District name (aka county) Example: Madison |
state | ∑ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (preferred) |
postalCode | ∑ | 0..1 | string | Postal code for area Example: 9132 |
country | ∑ | 0..1 | string | Country (can be ISO 3166 3 letter code) Binding: ISO Country Codes (required) |
period | ∑ | 0..1 | Period | Time period when address was/is in use Example: {"start":"2010-03-23","end":"2010-07-01"} |
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (required) | |
multipleBirth[x] | 0..1 | boolean, integer | Whether patient is part of a multiple birth | |
photo | 0..* | Attachment | Image of the patient | |
contact | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible) | |
name | 0..1 | HumanName | A name associated with the contact person | |
telecom | 0..* | ContactPoint | A contact detail for the person | |
address | 0..1 | Address | Address for the contact person | |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?! ∑ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example: home |
type | ∑ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example: both |
text | ∑ | 0..1 | string | Text representation of the address Example: 137 Nowhere Street, Erewhon 9132 |
line | ∑ | 0..* | string | Street name, number, direction & P.O. Box etc. Example: 137 Nowhere Street |
city | ∑ | 0..1 | string | Name of city, town etc. Example: Erewhon |
district | ∑ | 0..1 | string | District name (aka county) Example: Madison |
state | ∑ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (preferred) |
postalCode | ∑ | 0..1 | string | Postal code for area Example: 9132 |
country | ∑ | 0..1 | string | Country (can be ISO 3166 3 letter code) Binding: ISO Country Codes (required) |
period | ∑ | 0..1 | Period | Time period when address was/is in use Example: {"start":"2010-03-23","end":"2010-07-01"} |
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | |
organization | I | 0..1 | Reference(QICore-Organization) | Organization that is associated with the contact |
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |
communication | S | 0..* | BackboneElement | A list of Languages which may be used to communicate with the patient about his or her health |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: IETF BCP-47 (required) | |
preferred | 0..1 | boolean | Language preference indicator | |
careProvider | 0..* | Reference(QICore-Organization | QICore-Practitioner) | Patient's nominated primary care provider | |
managingOrganization | ∑ | 0..1 | Reference(QICore-Organization) | Organization that is the custodian of the patient record |
link | ?! | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
other | ?! | 1..1 | Reference(QICore-Patient) | The other patient resource that the link refers to |
type | ?! | 1..1 | code | replace | refer | seealso - type of link Binding: LinkType (required) |
Documentation for this format |
XML Template
JSON Template
todo
Other representations of profile: Schematron
Path | Name | Conformance | ValueSet |
Patient.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
Patient.extension [UriType[http://hl7.org/fhir/StructureDefinition/us-core-race]] | MU Race Value Set | preferred | MU Race Value Set |
Patient.extension [UriType[http://hl7.org/fhir/StructureDefinition/us-core-ethnicity]] | Ethnicity group | preferred | Ethnicity group |
Patient.extension [UriType[http://hl7.org/fhir/StructureDefinition/us-core-religion]] | v3 Code System ReligiousAffiliation | extensible | v3 Code System ReligiousAffiliation |
Patient.extension [UriType[http://hl7.org/fhir/StructureDefinition/patient-disability]] | Disability Value Set | preferred | Disability Value Set |
Patient.extension.extension [UriType[http://hl7.org/fhir/StructureDefinition/patient-nationality#code]] | ?ext | required | http://www.iso.org/iso/country_codes.htm |
Patient.extension [UriType[http://hl7.org/fhir/StructureDefinition/qicore-patient-militaryService]] | Military Service Codes | example | Military Service Codes |
Patient.extension.extension [UriType[http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial#reason]] | Problem Value Set | preferred | Problem Value Set |
Patient.telecom.system | ContactPointSystem | required | ContactPointSystem |
Patient.telecom.use | ContactPointUse | required | ContactPointUse |
Patient.gender | AdministrativeGender | required | AdministrativeGender |
Patient.address.use | AddressUse | required | AddressUse |
Patient.address.type | AddressType | required | AddressType |
Patient.address.state | USPS Two Letter Alphabetic Codes | preferred | USPS Two Letter Alphabetic Codes |
Patient.address.country | ?ext | required | http://www.iso.org/iso/country_codes.htm |
Patient.maritalStatus | Marital Status Codes | required | Marital Status Codes |
Patient.contact.relationship | PatientContactRelationship | extensible | PatientContactRelationship |
Patient.contact.address.use | AddressUse | required | AddressUse |
Patient.contact.address.type | AddressType | required | AddressType |
Patient.contact.address.state | USPS Two Letter Alphabetic Codes | preferred | USPS Two Letter Alphabetic Codes |
Patient.contact.address.country | ?ext | required | http://www.iso.org/iso/country_codes.htm |
Patient.contact.gender | AdministrativeGender | required | AdministrativeGender |
Patient.animal.species | AnimalSpecies | example | AnimalSpecies |
Patient.animal.breed | AnimalBreeds | example | AnimalBreeds |
Patient.animal.genderStatus | GenderStatus | example | GenderStatus |
Patient.communication.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
Patient.link.type | LinkType | required | LinkType |
Id | Path | Details | Requirements |
pat-1 | Patient.contact | SHALL at least contain a contact's details or a reference to an organization XPath: f:name or f:telecom or f:address or f:organization |